home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / getdir.arc / GETDIR.DOC < prev   
Encoding:
Text File  |  1985-10-27  |  14.0 KB  |  272 lines

  1.  
  2.  
  3. This is the user documentation for the disk directory utility
  4. GETDIR.COM.  GETDIR.COM is a load and stay resident in RAM
  5. program that operates much like Borland's SideKick.  If you find
  6. this program useful, you are requested to send $25.00 to:
  7.  
  8.                        JOHN J. NEWLIN
  9.                    4060-228 ROSENDA COURT
  10.                      SAN DIEGO, CA 92122
  11.  
  12. Contributors will receive free future updates of this program plus
  13. customization of the program, if requested.
  14.  
  15. GETDIR is a utility that will allow one to access any file in any
  16. directory on disk from an application program and return to that
  17. program without disturbing it.
  18.  
  19. GETDIR.COM should be loaded and operated as the last stay
  20. resident program in memory.  It operates fine on top of SideKick
  21. and may be removed from memory successfully as long as it is the
  22. last resident program loaded.
  23.  
  24. This program has been tested on an IBM PC with a color graphics
  25. board and a Leading Edge Color computer.  It should run fine on
  26. any true compatible and has been thoroughly tested on
  27. monochrome monitor machines.  It is designed primarily as a
  28. utility for hard disk based machines but will work fine with
  29. floppies.  To date (version 3.25), GETDIR may or may not work on the AT.
  30.  
  31. To load the program, type GETDIR at the dos prompt or load in
  32. from a batch file.
  33.  
  34. GETDIR is activated by pressing the Alt, Ctrl, or Shift key in conjunction
  35. with one of the ten function keys.  The default keys are F7 thru F10.  The
  36. user may specify up to four key combinations (total of 26 available) by
  37. placing key codes on the command line (from DOS or in a batch file) as
  38. follows:
  39.  
  40.                 GETDIR aa az s2 c0
  41.  
  42. In this example the user has specified Alt-A, Alt-Z, Shift-F2, and
  43. Ctrl-F10 as activation keys.  The order that the keys appear on the
  44. command line determine the type of alphabetic sort used as follows:
  45.  
  46.          Posit on CMD line                  Type Sort
  47.          -----------------         ---------------------------
  48.                1st                   by file name
  49.                2nd                   by file extension, then name
  50.                3rd                   by file extension, then date
  51.                4th                   no sort (fastest display)
  52.  
  53. In the above example, Alt-A would sort by file name, Alt-Z would
  54. sort by extension, then by name, Shift-F2 would sort by extension,
  55. then by date, and Ctrl-F10 would be no sort (fastest display).  In the
  56. case of the Alt key, six combinations are available.  They are:
  57.  
  58.                Alt-Q         Alt-W         Alt-A
  59.                Alt-S         Alt-Z         Alt-X
  60.  
  61. Upper or lower case is acceptable.  Note that these six keys are on the
  62. left side of the keyboard near the Alt key.
  63.  
  64. A copywrite notice and a message showing the amount of ram occupied by the
  65. program will be displayed.  To activate the utility, press one of the
  66. following default key combinations (or your own specified activation keys):
  67.  
  68.    Alt-f7  ==> current directory, no sort
  69.    Alt-f8  ==> current directory, primary sort on extension,
  70.                secondary sort on date
  71.    Alt-f9  ==> current directory, primary sort on extension,
  72.                secondary sort on name
  73.    Alt-f10 ==> current directory, sort on name
  74.  
  75. A window will pop up showing a maximum of 56 file, volume label,
  76. and subdirectory names sorted according to the alt-function key
  77. pressed.  If more than 56 files are in the directory, you can
  78. page through the files 56 at a time by pressing the Page Down
  79. key.  If more than 2 pages exist then use the 'B' or 'b' key to
  80. go back one page at a time.
  81.  
  82. If no files or subdirectories are in the directory, a message to
  83. that effect will appear.
  84.  
  85. Pressing Ctrl-H (or the Backspace key) will cause a help window
  86. appear that summarize the commands listed below.
  87.  
  88. A cursor will appear over the first entry in the directory.  The
  89. cursor may be moved from entry to entry by using the arrow keys
  90. (make sure num-lock is not active).  Volume label and directory names
  91. will blink. Pressing return with the cursor highlighting a directory
  92. entry will move to that directory.  You can return to the parent directory
  93. by pressing PgUp. Pressing return with the cursor highlighting a file name
  94. will pop-up a window showing the time, date, and attribute status data
  95. for that file.
  96.  
  97. Pressing Ctrl-A will permit changing the file attribute for the file
  98. currently under the cursor.
  99.  
  100. Pressing the DELETE key with the cursor highlighting a file name
  101. will pop-up a window asking for confirmation to delete the file.
  102. Pressing 'Y' or 'y' in response will delete the file and replace
  103. the file name under the cursor with [ DELETED ].  If the name
  104. under the cursor is a directory name, nothing will happen and the
  105. pop-up window will disappear.  Note that you cannot delete a read-
  106. only, hidden, or system file.
  107.  
  108. Pressing the INSERT key with the cursor highlighting a file name
  109. will pop-up a window asking for a new file name.  Pressing return
  110. at this point will remove the window with no action.  Entering a
  111. file name will cause the file to be renamed.  The new name will
  112. appear under the cursor.  This also applies to sub-directory names.
  113. You may re-name a subdirectory using this feature or you may even
  114. rename a volume label.  Renaming a sub-directory will not require
  115. rescanning the disk.   GETDIR automatically updates the directory
  116. catalog (see Ctrl-Z).
  117.  
  118. Pressing Ctrl-V with the cursor highlighting a file name will
  119. pop-up a window requesting entry of a destination directory.
  120. This feature allows moving a file from one directory to another
  121. without actually copying it.  Press return to exit.  Otherwise
  122. type in a valid directory name and the file will be moved and
  123. [ MOVED  ] will appear under the cursor.  If you entered an
  124. invalid directory name or if a file of that name already exists
  125. in the destination directory, an error message will appear and
  126. all will be as before.
  127.  
  128. Pressing Ctrl-B will cause all the files in the current directory to
  129. be moved to the destination directory.  This will empty the current
  130. directory of files (but not of subdirectories);
  131.  
  132. Pressing Ctrl-I will pop-up a window menu that will allow you to
  133. create or remove a sub-directory.  Just follow the DOS rules about
  134. directory creation/removal.  Pressing return or escape at the
  135. menu will return to the directory window.  If you are creating a new
  136. subdirectory, entering the name of the new subdirectory preceeded by
  137. a backslash (i.e., \NEWNAME) will cause that subdirectory to be added
  138. to the root directory.  Omitting the backslash (i.e., NEWNAME) will add
  139. the new subdirectory as a child of the active directory.  Subdirectory
  140. additions and deletions cause the directory catalog to automatically
  141. updated.
  142.  
  143. Pressing Ctrl-D will pop-up a window that will permit you to move
  144. from drive to drive.  CAUTION!! If no disk is in the drive
  145. selected, the program will fail and DOS will be hung up.  Any time a
  146. drive change is made, GETDIR automatically catalogs the new disk
  147. directories if Ctrl-Z or Ctrl-Y are activated.
  148.  
  149. Pressing Ctrl-L will permit you to create a volume label--providing
  150. the disk or diskette doesn't already have one.
  151.  
  152. You may tag individual files in a directory for moving or deleting by
  153. pressing the '+' key (for deletion) or the '*' key (for moving) with
  154. the cursor over the file.  The appropriate symbol will appear next to
  155. the file name.  A file may be untagged by pressing the '-' key with
  156. the cursor on a tagged file.  You may also untag all files by pressing
  157. Ctrl-U.  The limit on the number of files that may be moved or deleted
  158. at one time is 36.  After files are tagged, pressing Ctrl-E will pop
  159. up a window showing a list of the files tagged for deletion and asking
  160. permission to go ahead and delete them.  Pressing 'y' or 'Y' will cause
  161. the files tagged for deletion to be erased, 1 by 1, WITHOUT INDIVIDUAL
  162. CONFIRMATION.  Pressing Ctrl-F will pop up a window with a list of files
  163. to be moved.  Pressing 'y' or 'Y' will cause a prompt asking for the
  164. destination directory to be displayed.  If the entry is legal, the files
  165. be moved, one at a time, to the new directory.
  166.  
  167. DIRECTORY CATALOG & FILE SEARCH - Get dir will scan a disk, find all
  168. directories, and display a list of them.  This feature is limited to
  169. a maximum of 30 directories.  It takes about 12 seconds to find and list
  170. 21 directories on a 20MB hard disk with 12.8MB of data on it.  Press
  171. Ctrl-Z to activate the cataloger.  When it is finished, a window will open
  172. displaying all of the directories on the default disk.  This is automatically
  173. done whenever Ctrl-Z or Ctrl-Y are used after a default disk change is made.
  174. You can recall the window at any time with Ctrl-Z and move to any directory
  175. on the disk by entering the listed number associated with that directory.
  176. Number entries are two digits.  As soon as the second digit is entered, the
  177. indicated directory is activated.  An invalid number will return to the main
  178. display. ^P will give you a print out of your current directory catalog for
  179. the default disk.  Pressing return or ESC will exit the window without
  180. changing directories.
  181.    Pressing Ctrl-Y will activate the file search feature.  A prompt will
  182. appear asking for the file name to search for.  DOS wild cards are
  183. acceptable.  For example, if you wanted to know where every .COM file on
  184. your disk was and how many of them there are (144 on my disk!) just enter
  185. *.COM.  If the disk hasn't been cataloged yet then there will be a slight
  186. delay while the directories are found and cataloged (same as pressing Ctrl-Z).
  187. All matches to the entered file name string will be displayed on the screen
  188. 16 at a time with a pause for a key press between groups of 16 (you can use
  189. ^P at this point to get hard copy of files found).  At the end of the search,
  190. the total number of matches found will be displayed along with a search
  191. complete message.  If no match is found then a message to that effect will
  192. be displayed.  Search will look at ALL files on the disk - hidden, system,
  193. or whatever.  A search of 12.8MB for a file in a 4th level sub-directory
  194. on a 20MB hard disk takes 5.8 seconds!
  195.     Incidentally, the routine to find and catalog the directories is a
  196. recursive procedure utilizing DOS function calls 4Eh and 4Fh similar to
  197. the routine in C outlined by Mark Ackerman in the October 1985 issue of
  198. Tech Journal.  It's slower than a non-recursive routine but is very compact
  199. and easily implemented.  The search routine is not coupled with the
  200. recursive routine.  Instead it uses the knowledge of what directories
  201. currently exist on disk to search each for a match.  That's why it's so
  202. fast.  The same search using a routine coupled to the recursive directory
  203. catalog routine would take about three times longer.
  204.  
  205.    CAUTION -- THERE IS A FINE UTILITY CALLED SEARCH THAT IS ALSO A MEMORY
  206. RESIDENT PROGRAM.  SEARCH.COM PROVIDES A MEANS TO LOCATE NON-EXECUTABLE
  207. FILES FROM PROGRAMS THAT DO NOT SUPPORT DOS PATHS (LIKE WORDSTAR).  IF
  208. SEARCH IS ACTIVE AT THE SAME TIME AS GETDIR, GETDIR'S PERFORMANCE MAY BE
  209. DEROGATED AND IN FACT MAY HANG OR CRASH.  THE ADVICE IS TO DEACTIVATE
  210. SEARCH WHENEVER USING THE FILE SEARCH OR CATALOGING ROUTINES IN GETDIR.
  211.  
  212. You can go to the root directory of the current disk at any time by pressing
  213. the HOME key.  You can vertically traverse directories by pressing return
  214. with a directory name highlighted. If you wish to return to the parent
  215. directory, just press PgUp.
  216.  
  217. Pressing Ctrl-P will cause a print out of the files in the selected directory.
  218. CAUTION!!  If no printer is on line, the program will hang and you will have
  219. to reboot.  This will may corrected in the next version.  The problem is that
  220. many print spoolers appear as printers to the system.
  221.  
  222. Pressing the escape key will return you to DOS or you application program
  223. with the screen restored as it was.  If you wish to remove GETDIR from memory,
  224. just press Ctrl-Home from DOS. But make sure this program is the last resident
  225. program in memory or DOS will lose its way.
  226.  
  227. Some known problems & limitations are:
  228.  
  229.     1. This version is limited to 200 files max per directory.
  230.        Any more than this will cause run-time failure.
  231.     2. Max of 36 files can be tagged for either deletion or
  232.        moving at one time.  All files in a directory can be
  233.        moved with the ^B command.
  234.     3. A maximum of 30 directories is supported by the directory
  235.        cataloger.
  236.     4. Have experienced problems running MSDOS 2.11 on both
  237.        Leading Edge and Sperry machines.  Recommend using PC-DOS
  238.        2.0 or higher (it's faster).
  239.     5. May not support the PC AT.  (AT people.  I need to know
  240.        two things in order to have a shot at getting it going on
  241.        the AT.  1) What is the set of USER interrupt numbers for
  242.        the AT?  2) What is the address used in the AT for video ram
  243.        (both mono & color)).  This version uses a different user
  244.        interrupt number to process key strokes and may load ok on
  245.        the AT.
  246.     6. GETDIR file search and directory catalog routines are not
  247.        compatible with SEARCH.COM.
  248.  
  249. This program has run properly on an IBM XT (with Hercules mono card),
  250. a Leading Edge PC (color monitor/adaptor & PC DOS), a Sperry PC
  251. (color monitor/adaptor & PC DOS), and on several PCs running Bernoulli
  252. Boxes with PC DOS 3.1.
  253.  
  254. GETDIR contains an error handling routine that is designed to exit GETDIR
  255. gracefully and not disturb the parent application program in the event a
  256. fatal error occurs.  When a fatal error does occur, a window will open
  257. notifying the user of the error type and a signed integer that represents
  258. the IP value where the error occurred.  I would appreciate it if you notify
  259. me with these values if a fatal error occurs.  Also, try to recall what was
  260. happening when the error message popped up.  You will have to reboot your
  261. machine in order to get GETDIR going again after a fatal error.
  262.  
  263. User suggestions or comments are welcome.  Please contact me at
  264. the address below, via Compuserve E-mail, or by message in the IBMPC
  265. SIG.
  266.  
  267. John J. Newlin
  268. 4060-228 Rosenda Court
  269. San Diego, CA 92122
  270. (619) 455-6225
  271. CIS User No: 71535,665
  272.